Microservices
Updated On 24 March 2024 |
Min(s) read
Enterprise APIs
This is the basic version of Service Request Microservice APIs.
The V1.0.0 version of Service Request Microservice APIs contains three functional groups with their respective operations as follows.
Version 1.0.0
| TABLE NAME | OPERATION ID | URI | API DESCRIPTION | HTTP Method |
|---|---|---|---|---|
| Service Request Configuration | createServiceReqConfig | /orders/type/{typeId}/subType/{subTypeId}/serviceRequestConfiguration/{requestConfigId} | Creates new Service Request Configuration record with the given details | POST |
| updateServiceReqConfig | /orders/type/{typeId}/subType/{subTypeId}/serviceRequestConfiguration/{requestConfigId} | Updates new Service Request Configuration record for the existing details | PUT | |
| getServiceReqConfig | /orders/serviceRequestConfigurations | Get all the Service Request Configuration records | GET | |
| Service Request | createServiceReq | /orders/party/{partyId}/type/{typeId}/subtype/{subtypeId}/serviceRequest | Creates new Service Request record against the Service Request Configuration with the given details | POST |
| getRequestDetails | /orders/party/{partyId} | Get the Service Request record | GET | |
| updateServiceReq | /orders/serviceRequest/{requestId} | Updates the Service Request record | PUT | |
| approveServiceRequest | /orders/party/{partyId}/serviceRequest/{requestId}/approve | Approves a Service Request | POST | |
| rejectServiceRequest | /orders/party/{partyId}/serviceRequest/{requestId}/reject | Rejects a Service Request | POST | |
| withdrawServiceRequest | /orders/party/{partyId}/serviceRequest/{requestId}/withdraw | Withdraw a Service Request | POST | |
| getAllRequestDetailsByRequestId | /orders/serviceRequest/{requestId} | Returns the Service Request record(s) for comma separated requestIds | GET | |
| ReTrigger Service Request | reTriggerAwaitingSerReq | /orders/type/{typeId}/subType/{subTypeId}/status/statusCheck | Status check for Awaiting order periodically | PUT |
| API to update any TABLE | fileIngestor |
/system/file |
API to invoke any API with payload, pathParams & headers taken from json file packed in resources/configuration/release and create records asynchronously. Deprecated currently. | POST |
For the complete APIs specification, see service specification (Swagger) or Swagger JSON file.
Configure the following in the environment,
- SRMS_X_FUNCTIONS_KEY- used for Azure security
- SRMS_X_API_KEY - used for AWS security
- Authorization - JWT TOKEN OF MS
- SRMS_CLOUD_BASE_URL - MS base url upto version, v.x.x.x
Version 2.0.0
| TABLE NAME | OPERATION ID | URI | API DESCRIPTION | HTTP Method |
|---|---|---|---|---|
| Service Request Configuration | createServiceReqConfigV2 | /orders/type/{typeId}/subType/{subTypeId}/serviceRequestConfiguration/{requestConfigId} | Creates new Service Request Configuration record with the given details | POST |
| updateServiceReqConfigV2 | /orders/type/{typeId}/subType/{subTypeId}/serviceRequestConfiguration/{requestConfigId} | Updates new Service Request Configuration record for the existing details | PUT | |
| getServiceReqConfigV2 | /orders/serviceRequestConfigurations | Get all the Service Request Configuration records | GET | |
| Service Request | createServiceReqV2 | /orders/party/{partyId}/type/{typeId}/subtype/{subtypeId}/serviceRequest | Creates new Service Request record against the Service Request Configuration with the given details | POST |
| getRequestDetailsV2 | /orders/party/{partyId} | Get the Service Request record | GET | |
| updateServiceReqV2 | /orders/serviceRequest/{requestId} | Updates the Service Request record | PUT | |
| approveServiceRequestV2 | /orders/party/{partyId}/serviceRequest/{requestId}/approve | Approves a Service Request | POST | |
| rejectServiceRequestV2 | /orders/party/{partyId}/serviceRequest/{requestId}/reject | Rejects a Service Request | POST | |
| withdrawServiceRequestV2 | /orders/party/{partyId}/serviceRequest/{requestId}/withdraw | Withdraw a Service Request | POST | |
| getAllRequestDetailsByRequestIdV2 | /orders/serviceRequest/{requestId} | Returns the Service Request record(s) for comma separated requestIds | GET | |
| updateRequestDetailsV2 | /orders/serviceRequest/{requestId}/updateRequest | (NEW)Updates the details of Service Request | POST | |
| cancelRequestV2 | /orders/serviceRequest/{requestId}/cancelRequest | (NEW)Cancels a Service Request | POST | |
| getSRAttributeHistoryV2 | orders/serviceRequest/{requestId}/attributeHistory | (NEW)Gets the History of Service Requests | GET | |
| getServiceRequestBasedOnCriteriaV2 | /orders/serviceRequest | (NEW)Returns the Service Request(s) for a given customer based on a custom criteria, if present. Supports comma separated account Ids as input criteria, as well. | GET | |
| getSRAuditHistoryV2 | /orders/serviceRequest/{serviceRequestId}/actionHistoryDetails | Returns the Action History record(s) of the service request | GET | |
| ReTrigger Service Request | reTriggerAwaitingSerReqV2 | /orders/type/{typeId}/subType/{subTypeId}/status/statusCheck | Status check for Awaiting order periodically | PUT |
| API to update any TABLE | fileIngestorV2 | /system/file | API to invoke any API with payload, pathParams & headers taken from json file packed in resources/configuration/release and create records asynchronously.Deprecated currently. | POST |
For the complete APIs specification, see service specification (Swagger) or Swagger JSON file.
Postman collection and environment. These can be configured and used for all environments,
- SRMS_X_FUNCTIONS_KEY- used for azure security
- SRMS_X_API_KEY - used for aws security
- Authorization - JWT Token of MS
- SRMS_BASE_URL_v2 - MS base URL up to version, ideally used for v.2.0.0 (slash not included)
- SRMS_CLOUD_BASE_URL - MS base URL upto version, v.x.x.x
The following Postman collection and environment can be configured and used for all environments.
Deprecated APIs
Below is the list of deprecated APIs in Service Request Microservice.
| METHOD | OPERATION ID | URI | API DESCRIPTION | DEPRECATED RELEASE | LAST AVAILABLE VERSION |
|---|---|---|---|---|---|
| POST | fileIngestor | /system/file | API to update any table | 2021.01 | Deprecated permanently |
In this topic